Create Product

POST /api/v1/products

Description

Create a new product under a tenant account.

🔑 Authentication

This endpoint requires authentication via a Bearer Token.

Param	Value	Type
token	{{tenantUserAccessToken}}	string

Request Body

Name	Type	Description
name	string	The product name
overview	string	A short description of the product
requirements	array	List of requirements for using the product
display	string	Visibility of the product (PUBLIC, PRIVATE)
category	string	Product category (e.g., WHITE_LABEL)
bio	object	Additional bio information
bio.title	string	Title of the product bio
bio.description	string	Description of the product bio
bio.photo	string	URL of the product image
actionBy	string	The user performing the action
photo	string	URL of the product image
tenantId	string	The ID of the tenant creating the product

Configuration Settings

Each product can be configured for different platforms.

Mobile App Configuration

Name	Type	Description
label	string	Display name of the setting
key	string	Unique key identifier
value	string	Configuration value
required	boolean	Whether this field is required
valueType	string	Data type (e.g., string, boolean)
formType	string	Type of input form (e.g., input, dropdown)
formOptions	array	Available options for dropdown fields

Web App Configuration

The same configuration structure applies to:

• PWA App (config.pwaApp)
• Web App (config.webApp)
• Admin App (config.adminApp)

Product Classification

Products can be grouped based on industry categories.

Name	Type	Description
group	string	Industry classification (e.g., Health & Fitness)
tags	array	Tags associated with the product (e.g., Banking, Investing)

---

Example Request

POST /api/v1/products
Authorization: Bearer {{tenantUserAccessToken}}
Content-Type: application/json

{
  "name": "Sabi Finance Suite",
  "overview": "A complete financial solution for businesses",
  "requirements": [],
  "display": "PUBLIC",
  "category": "WHITE_LABEL",
  "bio": {
    "title": "Financial Suite",
    "description": "Manage your business finances efficiently",
    "photo": "https://example.com/product-image.png"
  },
  "actionBy": "{{$randomUUID}}",
  "photo": "https://example.com/product-image.png",
  "tenantId": "{{$randomTenantId}}",
  "config": {
    "mobileApp": [
      {
        "label": "Enable Auto Payments",
        "key": "auto_pay",
        "value": "true",
        "required": true,
        "valueType": "boolean",
        "formType": "toggle",
        "formOptions": []
      }
    ]
  },
  "services": ["payment-processing"],
  "classification": [
    {
      "group": "Finance",
      "tags": ["Banking", "Investing", "Payments"]
    }
  ]
}

Response

Response Code: 200 - OK

{
  "message": "Product Creation Acknowledged",
  "code": "{{$randomCode}}",
  "apiKey": "{{$randomApiKey}}"
}